Esx Settings SoftwareInfo
The Esx Settings SoftwareInfo schema contains information that describes the desired software specification for an ESX host.
This schema was added in vSphere API 7.0.0.0.
{
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"alternative_images": {
"alternative_images": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}
}
}Base image of the ESX.
This property was added in vSphere API 7.0.0.0.
OEM customization on top of given base image. The components in this customization override the components in the base base image.
This property was added in vSphere API 7.0.0.0.
If missing or null, no OEM customization will be applied.
Information about the components in the software specification.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.
Information about the solutions in the software specification.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.solution.
Information about the Hardware Support Packages (HSP) configured.
This property was added in vSphere API 7.0.0.0.
If missing or null, no Hardware Support Package (HSP) is specified for the cluster.
Information about the components to be removed in the software specification.
This property was added in vSphere API 8.0.3.0.
This property is optional because it was added in a newer version than its parent node.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.
Alternative Images apart from the Default Image
This property was added in vSphere API 9.0.0.0.
If missing or null, no alternative image will be part of the software specification. Image ID supports only the following ASCII characters [a-z][A-Z][0-9][-] Case will be ignored when comparing identifiers "IMAGE-1" is equal to "image-1"
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.image. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.image.